API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

jobs

Retrieves a jobs resource.

Retrieves a jobs resource.

Authorizations:
JWT
path Parameters
id
required
string

jobs identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "jobType": "string",
  • "jobTypeStringIndications": "string",
  • "jobTypeStringParameters": "string",
  • "executed": true,
  • "finishedExecutionDate": "2019-08-24T14:15:22Z",
  • "jobStartDate": "2019-08-24T14:15:22Z",
  • "jobEndDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "shortcode": "JOB",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "typeName": "string",
  • "runningTime": 0,
  • "customPropertiesListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Replaces the jobs resource.

Replaces the jobs resource.

Authorizations:
JWT
path Parameters
id
required
string

jobs identifier

Request Body schema:
required

The updated jobs resource

jobType
required
string
jobTypeStringIndications
string or null
jobTypeStringParameters
string or null
executed
required
boolean
finishedExecutionDate
string or null <date-time>
resultLogString
string or null
jobStartDate
required
string <date-time>
jobEndDate
required
string <date-time>
metadata
Array of strings or null
notes
string or null
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>

Responses

Request samples

Content type
{
  • "jobType": "string",
  • "jobTypeStringIndications": "string",
  • "jobTypeStringParameters": "string",
  • "executed": true,
  • "finishedExecutionDate": "2019-08-24T14:15:22Z",
  • "resultLogString": "string",
  • "jobStartDate": "2019-08-24T14:15:22Z",
  • "jobEndDate": "2019-08-24T14:15:22Z",
  • "metadata": [
    ],
  • "notes": "string",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "jobType": "string",
  • "jobTypeStringIndications": "string",
  • "jobTypeStringParameters": "string",
  • "executed": true,
  • "finishedExecutionDate": "2019-08-24T14:15:22Z",
  • "jobStartDate": "2019-08-24T14:15:22Z",
  • "jobEndDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "shortcode": "JOB",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "typeName": "string",
  • "runningTime": 0,
  • "customPropertiesListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Removes the jobs resource.

Removes the jobs resource.

Authorizations:
JWT
path Parameters
id
required
string

jobs identifier

Responses